Add teardown phase to doctests #2577
Open
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
Awesome, thank you! For testing, you could also modify some global variable and observe the side effect? E.g. have a global counter that is incremented in |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Resolves #2058, resolves #2566.
This PR introduces the doc meta key
DocTestTeardownand thejldoctestkwargteardown, both of which contain code code that gets executed after the doctest itself. (after every block, let's keep the discussion about how to handle multiple same-named blocks in #2567).If the Documenter maintainers (@mortenpi @fredrikekre ) still like this, I'll continue with adding this new feature to the documentation and add some tests.
My current only idea for testing is to add some print statements as teardown code and then compare the output, similar to the existing doctest tests in
Documenter.jl/test/doctests/doctests.jl
Line 184 in 7c1aea5
cc @maleadt @fingolfin